package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.AttendPunchTimeAddDTO;
import org.jsola.hr.dto.AttendPunchTimeUpdateDTO;
import org.jsola.hr.query.AttendPunchTimeQuery;
import org.jsola.hr.vo.AttendPunchTimeListVO;
import org.jsola.hr.vo.AttendPunchTimeVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-考勤打卡时间")
public interface IAttendPunchTimeControllerAPI {

    /**
     * 新增考勤打卡时间
     * @param attendPunchTimeAddDTO 考勤打卡时间新增实体
     * @return 考勤打卡时间展示对象
     */
    @ApiOperation(value = "新增考勤打卡时间")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchTimeAddDTO", dataType = "AttendPunchTimeAddDTO", value = "新增考勤打卡时间", paramType = "body")
    })
    Result<AttendPunchTimeVO> save(AttendPunchTimeAddDTO attendPunchTimeAddDTO);


    /**
     * 修改考勤打卡时间
     * @param attendPunchTimeUpdateDTO 考勤打卡时间
     * @return 更新数量
     */
    @ApiOperation(value = "修改考勤打卡时间")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchTimeUpdateDTO", dataType = "AttendPunchTimeUpdateDTO", value = "修改考勤打卡时间", paramType = "body")
    })
    Result<Integer> update(AttendPunchTimeUpdateDTO attendPunchTimeUpdateDTO);




    /**
     * 删除单个考勤打卡时间，彻底删除
     * @param attendPunchTimeId 考勤打卡时间id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个考勤打卡时间，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchTimeId", dataType = "String", value = "考勤打卡时间id", paramType = "path")
    })
    Result<Integer> delete(String attendPunchTimeId);


    /**
     * 批量删除考勤打卡时间，彻底删除
     * @param attendPunchTimeIds 考勤打卡时间id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除考勤打卡时间，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchTimeIds", dataType = "String[]", value = "考勤打卡时间id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] attendPunchTimeIds);


    /**
     * 根据考勤打卡时间id查询考勤打卡时间详情
     * @param attendPunchTimeId 考勤打卡时间id
     * @return 考勤打卡时间详情
     */
    @ApiOperation(value="根据考勤打卡时间id查询考勤打卡时间详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchTimeId", dataType = "String", value = "考勤打卡时间id", paramType = "path")
    })
    Result<AttendPunchTimeVO> findById(String attendPunchTimeId);


    /**
     * 查询考勤打卡时间
     * @param attendPunchTimeQuery 考勤打卡时间查询参数
     * @return page
     */
    @ApiOperation(value="查询考勤打卡时间")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchTimeQuery", dataType = "AttendPunchTimeQuery", value = "考勤打卡时间查询参数", paramType = "query")
    })
    Result<List<AttendPunchTimeListVO>> listAll(AttendPunchTimeQuery attendPunchTimeQuery);


     /**
     * 分页查询考勤打卡时间
     * @param attendPunchTimeQuery 考勤打卡时间查询参数
     * @return page
     */
    @ApiOperation(value="分页查询考勤打卡时间")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPunchTimeQuery", dataType = "AttendPunchTimeQuery", value = "考勤打卡时间查询参数", paramType = "query")
    })
    Result<Page<AttendPunchTimeListVO>> page(AttendPunchTimeQuery attendPunchTimeQuery);


}

